API

Logistics APIs

GET logistics/stock-locations/{stockLocationId}

Stock location details for provided details

HTTP method GET
URI https://api.rambase.net/logistics/stock-locations/{stockLocationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockLocationId} Stock location identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1989, version 19

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<StockLocation>
2
     <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
3
     <Status
Status

Status of the stock location

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of stock location

>{String}</Name>
6
     <Label
Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>
7
     <Description
Description

Description of stock location

>{String}</Description>
8
     <TreeLevel
TreeLevel

Level in the stock location tree. 0 is the root.

>{Integer}</TreeLevel>
9
     <IsBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

>{Boolean}</IsBlockedForPicking>
10
     <IsBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

>{Boolean}</IsBlockedForStockAssignments>
11
     <IsBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

>{Boolean}</IsBlockedForStock>
12
     <HasStock
HasStock

Determines whether or not there is a stock available for this stock location

>{Boolean}</HasStock>
13
     <ContainsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

>{Boolean}</ContainsSecondHandProducts>
14
     <ContainsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

>{Boolean}</ContainsSparepartsUsedForRepair>
15
     <HasReplenishmentConfigurations
HasReplenishmentConfigurations

This stock location contains replenishment configurations which contains a products replenishment point and can contain a replenishment quantity

This field is greyed out because it is an expandable field. You have to add $expand=HasReplenishmentConfigurations in your request URI to get this field

>{Boolean}</HasReplenishmentConfigurations>
16
     <HasChildren
HasChildren

True if stock location has any child stock locations

This field is greyed out because it is an expandable field. You have to add $expand=HasChildren in your request URI to get this field

>{Boolean}</HasChildren>
17
     <NumberOfChildren
NumberOfChildren

Number of stock locations with current stock location as parent

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfChildren in your request URI to get this field

>{Integer}</NumberOfChildren>
18
     <Location>
19
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
20
          <Name
Name

Name of location

>{String}</Name>
21
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
22
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
23
     </Location>
24
     <ParentStockLocations>
25
          <ParentStockLocation>
26
               <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
27
               <Name
Name

Name of stock location

>{String}</Name>
28
               <TreeLevel
TreeLevel

Level in the stock location tree. 0 is the root.

>{Integer}</TreeLevel>
29
               <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
30
          </ParentStockLocation>
31
     </ParentStockLocations>
32
</StockLocation>
1
{
2
     "stockLocation": {
3
          "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
4
          "status
Status

Status of the stock location

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of stock location

": "{String}",
7
          "label
Label

Name of current- and parent stock locations, including seperator for location

": "{String}",
8
          "description
Description

Description of stock location

": "{String}",
9
          "treeLevel
TreeLevel

Level in the stock location tree. 0 is the root.

": "{Integer}",
10
          "isBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

": "{Boolean}",
11
          "isBlockedForStockAssignments
IsBlockedForStockAssignments

True if block linking

": "{Boolean}",
12
          "isBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

": "{Boolean}",
13
          "hasStock
HasStock

Determines whether or not there is a stock available for this stock location

": "{Boolean}",
14
          "containsSecondHandProducts
ContainsSecondHandProducts

True if location contains second hand products. Location will be blocked for stock assignments.

": "{Boolean}",
15
          "containsSparepartsUsedForRepair
ContainsSparepartsUsedForRepair

True if location contains spareparts used for repair.

": "{Boolean}",
16
          "hasReplenishmentConfigurations
HasReplenishmentConfigurations

This stock location contains replenishment configurations which contains a products replenishment point and can contain a replenishment quantity

This field is greyed out because it is an expandable field. You have to add $expand=HasReplenishmentConfigurations in your request URI to get this field

": "{Boolean}",
17
          "hasChildren
HasChildren

True if stock location has any child stock locations

This field is greyed out because it is an expandable field. You have to add $expand=HasChildren in your request URI to get this field

": "{Boolean}",
18
          "numberOfChildren
NumberOfChildren

Number of stock locations with current stock location as parent

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfChildren in your request URI to get this field

": "{Integer}",
19
          "location": {
20
               "locationId
LocationId

Location identifier

": "{Integer}",
21
               "name
Name

Name of location

": "{String}",
22
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
23
               "locationLink
LocationLink

Location reference

": "{String}"
24
          },
25
          "parentStockLocations": [
26
               {
27
                    "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
28
                    "name
Name

Name of stock location

": "{String}",
29
                    "treeLevel
TreeLevel

Level in the stock location tree. 0 is the root.

": "{Integer}",
30
                    "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
31
               }
32
          ]
33
     }
34
}

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}